<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="netapp_v1beta1.html">NetApp API</a> . <a href="netapp_v1beta1.projects.html">projects</a> . <a href="netapp_v1beta1.projects.locations.html">locations</a> . <a href="netapp_v1beta1.projects.locations.volumes.html">volumes</a> . <a href="netapp_v1beta1.projects.locations.volumes.replications.html">replications</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, replicationId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a new replication for a volume.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a replication.</p>
<p class="toc_element">
  <code><a href="#establishPeering">establishPeering(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Establish replication peering.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Describe a replication for a volume.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns descriptions of all replications for a volume.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the settings of a specific replication.</p>
<p class="toc_element">
  <code><a href="#resume">resume(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Resume Cross Region Replication.</p>
<p class="toc_element">
  <code><a href="#reverseDirection">reverseDirection(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Reverses direction of replication. Source becomes destination and destination becomes source.</p>
<p class="toc_element">
  <code><a href="#stop">stop(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Stop Cross Region Replication.</p>
<p class="toc_element">
  <code><a href="#sync">sync(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Syncs the replication. This will invoke one time volume data transfer from source to destination.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, replicationId=None, x__xgafv=None)</code>
  <pre>Create a new replication for a volume.

Args:
  parent: string, Required. The NetApp volume to create the replications of, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Replication is a nested resource under Volume, that describes a cross-region replication relationship between 2 volumes in different regions.
  &quot;clusterLocation&quot;: &quot;A String&quot;, # Optional. Location of the user cluster.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Replication create time.
  &quot;description&quot;: &quot;A String&quot;, # A description about this replication relationship.
  &quot;destinationVolume&quot;: &quot;A String&quot;, # Output only. Full name of destination volume resource. Example : &quot;projects/{project}/locations/{location}/volumes/{volume_id}&quot;
  &quot;destinationVolumeParameters&quot;: { # DestinationVolumeParameters specify input parameters used for creating destination volume. # Required. Input only. Destination volume parameters
    &quot;description&quot;: &quot;A String&quot;, # Description for the destination volume.
    &quot;shareName&quot;: &quot;A String&quot;, # Destination volume&#x27;s share name. If not specified, source volume&#x27;s share name will be used.
    &quot;storagePool&quot;: &quot;A String&quot;, # Required. Existing destination StoragePool name.
    &quot;tieringPolicy&quot;: { # Defines tiering policy for the volume. # Optional. Tiering policy for the volume.
      &quot;coolingThresholdDays&quot;: 42, # Optional. Time in days to mark the volume&#x27;s data block as cold and make it eligible for tiering, can be range from 2-183. Default is 31.
      &quot;hotTierBypassModeEnabled&quot;: True or False, # Optional. Flag indicating that the hot tier bypass mode is enabled. Default is false. This is only applicable to Flex service level.
      &quot;tierAction&quot;: &quot;A String&quot;, # Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.
    },
    &quot;volumeId&quot;: &quot;A String&quot;, # Desired destination volume resource id. If not specified, source volume&#x27;s resource id will be used. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
  },
  &quot;healthy&quot;: True or False, # Output only. Condition of the relationship. Can be one of the following: - true: The replication relationship is healthy. It has not missed the most recent scheduled transfer. - false: The replication relationship is not healthy. It has missed the most recent scheduled transfer.
  &quot;hybridPeeringDetails&quot;: { # HybridPeeringDetails contains details about the hybrid peering. # Output only. Hybrid peering details.
    &quot;command&quot;: &quot;A String&quot;, # Output only. Copy-paste-able commands to be used on user&#x27;s ONTAP to accept peering requests.
    &quot;commandExpiryTime&quot;: &quot;A String&quot;, # Output only. Expiration time for the peering command to be executed on user&#x27;s ONTAP.
    &quot;passphrase&quot;: &quot;A String&quot;, # Output only. Temporary passphrase generated to accept cluster peering command.
    &quot;peerClusterName&quot;: &quot;A String&quot;, # Output only. Name of the user&#x27;s local source cluster to be peered with the destination cluster.
    &quot;peerSvmName&quot;: &quot;A String&quot;, # Output only. Name of the user&#x27;s local source vserver svm to be peered with the destination vserver svm.
    &quot;peerVolumeName&quot;: &quot;A String&quot;, # Output only. Name of the user&#x27;s local source volume to be peered with the destination volume.
    &quot;subnetIp&quot;: &quot;A String&quot;, # Output only. IP address of the subnet.
  },
  &quot;hybridReplicationType&quot;: &quot;A String&quot;, # Output only. Type of the hybrid replication.
  &quot;hybridReplicationUserCommands&quot;: { # UserCommands contains the commands to be executed by the customer. # Output only. Copy pastable snapmirror commands to be executed on onprem cluster by the customer.
    &quot;commands&quot;: [ # Output only. List of commands to be executed by the customer.
      &quot;A String&quot;,
    ],
  },
  &quot;labels&quot;: { # Resource labels to represent user provided metadata.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;mirrorState&quot;: &quot;A String&quot;, # Output only. Indicates the state of mirroring.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.
  &quot;replicationSchedule&quot;: &quot;A String&quot;, # Required. Indicates the schedule for replication.
  &quot;role&quot;: &quot;A String&quot;, # Output only. Indicates whether this points to source or destination.
  &quot;sourceVolume&quot;: &quot;A String&quot;, # Output only. Full name of source volume resource. Example : &quot;projects/{project}/locations/{location}/volumes/{volume_id}&quot;
  &quot;state&quot;: &quot;A String&quot;, # Output only. State of the replication.
  &quot;stateDetails&quot;: &quot;A String&quot;, # Output only. State details of the replication.
  &quot;transferStats&quot;: { # TransferStats reports all statistics related to replication transfer. # Output only. Replication transfer statistics.
    &quot;lagDuration&quot;: &quot;A String&quot;, # Lag duration indicates the duration by which Destination region volume content lags behind the primary region volume content.
    &quot;lastTransferBytes&quot;: &quot;A String&quot;, # Last transfer size in bytes.
    &quot;lastTransferDuration&quot;: &quot;A String&quot;, # Time taken during last transfer.
    &quot;lastTransferEndTime&quot;: &quot;A String&quot;, # Time when last transfer completed.
    &quot;lastTransferError&quot;: &quot;A String&quot;, # A message describing the cause of the last transfer failure.
    &quot;totalTransferDuration&quot;: &quot;A String&quot;, # Cumulative time taken across all transfers for the replication relationship.
    &quot;transferBytes&quot;: &quot;A String&quot;, # Cumulative bytes transferred so far for the replication relationship.
    &quot;updateTime&quot;: &quot;A String&quot;, # Time when progress was updated last.
  },
}

  replicationId: string, Required. ID of the replication to create. Must be unique within the parent resource. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes a replication.

Args:
  name: string, Required. The replication resource name, in the format `projects/*/locations/*/volumes/*/replications/{replication_id}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="establishPeering">establishPeering(name, body=None, x__xgafv=None)</code>
  <pre>Establish replication peering.

Args:
  name: string, Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # EstablishPeeringRequest establishes cluster and svm peerings between the source and the destination replications.
  &quot;peerClusterName&quot;: &quot;A String&quot;, # Required. Name of the user&#x27;s local source cluster to be peered with the destination cluster.
  &quot;peerIpAddresses&quot;: [ # Optional. List of IPv4 ip addresses to be used for peering.
    &quot;A String&quot;,
  ],
  &quot;peerSvmName&quot;: &quot;A String&quot;, # Required. Name of the user&#x27;s local source vserver svm to be peered with the destination vserver svm.
  &quot;peerVolumeName&quot;: &quot;A String&quot;, # Required. Name of the user&#x27;s local source volume to be peered with the destination volume.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Describe a replication for a volume.

Args:
  name: string, Required. The replication resource name, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Replication is a nested resource under Volume, that describes a cross-region replication relationship between 2 volumes in different regions.
  &quot;clusterLocation&quot;: &quot;A String&quot;, # Optional. Location of the user cluster.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Replication create time.
  &quot;description&quot;: &quot;A String&quot;, # A description about this replication relationship.
  &quot;destinationVolume&quot;: &quot;A String&quot;, # Output only. Full name of destination volume resource. Example : &quot;projects/{project}/locations/{location}/volumes/{volume_id}&quot;
  &quot;destinationVolumeParameters&quot;: { # DestinationVolumeParameters specify input parameters used for creating destination volume. # Required. Input only. Destination volume parameters
    &quot;description&quot;: &quot;A String&quot;, # Description for the destination volume.
    &quot;shareName&quot;: &quot;A String&quot;, # Destination volume&#x27;s share name. If not specified, source volume&#x27;s share name will be used.
    &quot;storagePool&quot;: &quot;A String&quot;, # Required. Existing destination StoragePool name.
    &quot;tieringPolicy&quot;: { # Defines tiering policy for the volume. # Optional. Tiering policy for the volume.
      &quot;coolingThresholdDays&quot;: 42, # Optional. Time in days to mark the volume&#x27;s data block as cold and make it eligible for tiering, can be range from 2-183. Default is 31.
      &quot;hotTierBypassModeEnabled&quot;: True or False, # Optional. Flag indicating that the hot tier bypass mode is enabled. Default is false. This is only applicable to Flex service level.
      &quot;tierAction&quot;: &quot;A String&quot;, # Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.
    },
    &quot;volumeId&quot;: &quot;A String&quot;, # Desired destination volume resource id. If not specified, source volume&#x27;s resource id will be used. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
  },
  &quot;healthy&quot;: True or False, # Output only. Condition of the relationship. Can be one of the following: - true: The replication relationship is healthy. It has not missed the most recent scheduled transfer. - false: The replication relationship is not healthy. It has missed the most recent scheduled transfer.
  &quot;hybridPeeringDetails&quot;: { # HybridPeeringDetails contains details about the hybrid peering. # Output only. Hybrid peering details.
    &quot;command&quot;: &quot;A String&quot;, # Output only. Copy-paste-able commands to be used on user&#x27;s ONTAP to accept peering requests.
    &quot;commandExpiryTime&quot;: &quot;A String&quot;, # Output only. Expiration time for the peering command to be executed on user&#x27;s ONTAP.
    &quot;passphrase&quot;: &quot;A String&quot;, # Output only. Temporary passphrase generated to accept cluster peering command.
    &quot;peerClusterName&quot;: &quot;A String&quot;, # Output only. Name of the user&#x27;s local source cluster to be peered with the destination cluster.
    &quot;peerSvmName&quot;: &quot;A String&quot;, # Output only. Name of the user&#x27;s local source vserver svm to be peered with the destination vserver svm.
    &quot;peerVolumeName&quot;: &quot;A String&quot;, # Output only. Name of the user&#x27;s local source volume to be peered with the destination volume.
    &quot;subnetIp&quot;: &quot;A String&quot;, # Output only. IP address of the subnet.
  },
  &quot;hybridReplicationType&quot;: &quot;A String&quot;, # Output only. Type of the hybrid replication.
  &quot;hybridReplicationUserCommands&quot;: { # UserCommands contains the commands to be executed by the customer. # Output only. Copy pastable snapmirror commands to be executed on onprem cluster by the customer.
    &quot;commands&quot;: [ # Output only. List of commands to be executed by the customer.
      &quot;A String&quot;,
    ],
  },
  &quot;labels&quot;: { # Resource labels to represent user provided metadata.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;mirrorState&quot;: &quot;A String&quot;, # Output only. Indicates the state of mirroring.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.
  &quot;replicationSchedule&quot;: &quot;A String&quot;, # Required. Indicates the schedule for replication.
  &quot;role&quot;: &quot;A String&quot;, # Output only. Indicates whether this points to source or destination.
  &quot;sourceVolume&quot;: &quot;A String&quot;, # Output only. Full name of source volume resource. Example : &quot;projects/{project}/locations/{location}/volumes/{volume_id}&quot;
  &quot;state&quot;: &quot;A String&quot;, # Output only. State of the replication.
  &quot;stateDetails&quot;: &quot;A String&quot;, # Output only. State details of the replication.
  &quot;transferStats&quot;: { # TransferStats reports all statistics related to replication transfer. # Output only. Replication transfer statistics.
    &quot;lagDuration&quot;: &quot;A String&quot;, # Lag duration indicates the duration by which Destination region volume content lags behind the primary region volume content.
    &quot;lastTransferBytes&quot;: &quot;A String&quot;, # Last transfer size in bytes.
    &quot;lastTransferDuration&quot;: &quot;A String&quot;, # Time taken during last transfer.
    &quot;lastTransferEndTime&quot;: &quot;A String&quot;, # Time when last transfer completed.
    &quot;lastTransferError&quot;: &quot;A String&quot;, # A message describing the cause of the last transfer failure.
    &quot;totalTransferDuration&quot;: &quot;A String&quot;, # Cumulative time taken across all transfers for the replication relationship.
    &quot;transferBytes&quot;: &quot;A String&quot;, # Cumulative bytes transferred so far for the replication relationship.
    &quot;updateTime&quot;: &quot;A String&quot;, # Time when progress was updated last.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Returns descriptions of all replications for a volume.

Args:
  parent: string, Required. The volume for which to retrieve replication information, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`. (required)
  filter: string, List filter.
  orderBy: string, Sort results. Supported values are &quot;name&quot;, &quot;name desc&quot; or &quot;&quot; (unsorted).
  pageSize: integer, The maximum number of items to return.
  pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # ListReplicationsResponse is the result of ListReplicationsRequest.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.
  &quot;replications&quot;: [ # A list of replications in the project for the specified volume.
    { # Replication is a nested resource under Volume, that describes a cross-region replication relationship between 2 volumes in different regions.
      &quot;clusterLocation&quot;: &quot;A String&quot;, # Optional. Location of the user cluster.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. Replication create time.
      &quot;description&quot;: &quot;A String&quot;, # A description about this replication relationship.
      &quot;destinationVolume&quot;: &quot;A String&quot;, # Output only. Full name of destination volume resource. Example : &quot;projects/{project}/locations/{location}/volumes/{volume_id}&quot;
      &quot;destinationVolumeParameters&quot;: { # DestinationVolumeParameters specify input parameters used for creating destination volume. # Required. Input only. Destination volume parameters
        &quot;description&quot;: &quot;A String&quot;, # Description for the destination volume.
        &quot;shareName&quot;: &quot;A String&quot;, # Destination volume&#x27;s share name. If not specified, source volume&#x27;s share name will be used.
        &quot;storagePool&quot;: &quot;A String&quot;, # Required. Existing destination StoragePool name.
        &quot;tieringPolicy&quot;: { # Defines tiering policy for the volume. # Optional. Tiering policy for the volume.
          &quot;coolingThresholdDays&quot;: 42, # Optional. Time in days to mark the volume&#x27;s data block as cold and make it eligible for tiering, can be range from 2-183. Default is 31.
          &quot;hotTierBypassModeEnabled&quot;: True or False, # Optional. Flag indicating that the hot tier bypass mode is enabled. Default is false. This is only applicable to Flex service level.
          &quot;tierAction&quot;: &quot;A String&quot;, # Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.
        },
        &quot;volumeId&quot;: &quot;A String&quot;, # Desired destination volume resource id. If not specified, source volume&#x27;s resource id will be used. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
      },
      &quot;healthy&quot;: True or False, # Output only. Condition of the relationship. Can be one of the following: - true: The replication relationship is healthy. It has not missed the most recent scheduled transfer. - false: The replication relationship is not healthy. It has missed the most recent scheduled transfer.
      &quot;hybridPeeringDetails&quot;: { # HybridPeeringDetails contains details about the hybrid peering. # Output only. Hybrid peering details.
        &quot;command&quot;: &quot;A String&quot;, # Output only. Copy-paste-able commands to be used on user&#x27;s ONTAP to accept peering requests.
        &quot;commandExpiryTime&quot;: &quot;A String&quot;, # Output only. Expiration time for the peering command to be executed on user&#x27;s ONTAP.
        &quot;passphrase&quot;: &quot;A String&quot;, # Output only. Temporary passphrase generated to accept cluster peering command.
        &quot;peerClusterName&quot;: &quot;A String&quot;, # Output only. Name of the user&#x27;s local source cluster to be peered with the destination cluster.
        &quot;peerSvmName&quot;: &quot;A String&quot;, # Output only. Name of the user&#x27;s local source vserver svm to be peered with the destination vserver svm.
        &quot;peerVolumeName&quot;: &quot;A String&quot;, # Output only. Name of the user&#x27;s local source volume to be peered with the destination volume.
        &quot;subnetIp&quot;: &quot;A String&quot;, # Output only. IP address of the subnet.
      },
      &quot;hybridReplicationType&quot;: &quot;A String&quot;, # Output only. Type of the hybrid replication.
      &quot;hybridReplicationUserCommands&quot;: { # UserCommands contains the commands to be executed by the customer. # Output only. Copy pastable snapmirror commands to be executed on onprem cluster by the customer.
        &quot;commands&quot;: [ # Output only. List of commands to be executed by the customer.
          &quot;A String&quot;,
        ],
      },
      &quot;labels&quot;: { # Resource labels to represent user provided metadata.
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;mirrorState&quot;: &quot;A String&quot;, # Output only. Indicates the state of mirroring.
      &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.
      &quot;replicationSchedule&quot;: &quot;A String&quot;, # Required. Indicates the schedule for replication.
      &quot;role&quot;: &quot;A String&quot;, # Output only. Indicates whether this points to source or destination.
      &quot;sourceVolume&quot;: &quot;A String&quot;, # Output only. Full name of source volume resource. Example : &quot;projects/{project}/locations/{location}/volumes/{volume_id}&quot;
      &quot;state&quot;: &quot;A String&quot;, # Output only. State of the replication.
      &quot;stateDetails&quot;: &quot;A String&quot;, # Output only. State details of the replication.
      &quot;transferStats&quot;: { # TransferStats reports all statistics related to replication transfer. # Output only. Replication transfer statistics.
        &quot;lagDuration&quot;: &quot;A String&quot;, # Lag duration indicates the duration by which Destination region volume content lags behind the primary region volume content.
        &quot;lastTransferBytes&quot;: &quot;A String&quot;, # Last transfer size in bytes.
        &quot;lastTransferDuration&quot;: &quot;A String&quot;, # Time taken during last transfer.
        &quot;lastTransferEndTime&quot;: &quot;A String&quot;, # Time when last transfer completed.
        &quot;lastTransferError&quot;: &quot;A String&quot;, # A message describing the cause of the last transfer failure.
        &quot;totalTransferDuration&quot;: &quot;A String&quot;, # Cumulative time taken across all transfers for the replication relationship.
        &quot;transferBytes&quot;: &quot;A String&quot;, # Cumulative bytes transferred so far for the replication relationship.
        &quot;updateTime&quot;: &quot;A String&quot;, # Time when progress was updated last.
      },
    },
  ],
  &quot;unreachable&quot;: [ # Locations that could not be reached.
    &quot;A String&quot;,
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates the settings of a specific replication.

Args:
  name: string, Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Replication is a nested resource under Volume, that describes a cross-region replication relationship between 2 volumes in different regions.
  &quot;clusterLocation&quot;: &quot;A String&quot;, # Optional. Location of the user cluster.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Replication create time.
  &quot;description&quot;: &quot;A String&quot;, # A description about this replication relationship.
  &quot;destinationVolume&quot;: &quot;A String&quot;, # Output only. Full name of destination volume resource. Example : &quot;projects/{project}/locations/{location}/volumes/{volume_id}&quot;
  &quot;destinationVolumeParameters&quot;: { # DestinationVolumeParameters specify input parameters used for creating destination volume. # Required. Input only. Destination volume parameters
    &quot;description&quot;: &quot;A String&quot;, # Description for the destination volume.
    &quot;shareName&quot;: &quot;A String&quot;, # Destination volume&#x27;s share name. If not specified, source volume&#x27;s share name will be used.
    &quot;storagePool&quot;: &quot;A String&quot;, # Required. Existing destination StoragePool name.
    &quot;tieringPolicy&quot;: { # Defines tiering policy for the volume. # Optional. Tiering policy for the volume.
      &quot;coolingThresholdDays&quot;: 42, # Optional. Time in days to mark the volume&#x27;s data block as cold and make it eligible for tiering, can be range from 2-183. Default is 31.
      &quot;hotTierBypassModeEnabled&quot;: True or False, # Optional. Flag indicating that the hot tier bypass mode is enabled. Default is false. This is only applicable to Flex service level.
      &quot;tierAction&quot;: &quot;A String&quot;, # Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.
    },
    &quot;volumeId&quot;: &quot;A String&quot;, # Desired destination volume resource id. If not specified, source volume&#x27;s resource id will be used. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
  },
  &quot;healthy&quot;: True or False, # Output only. Condition of the relationship. Can be one of the following: - true: The replication relationship is healthy. It has not missed the most recent scheduled transfer. - false: The replication relationship is not healthy. It has missed the most recent scheduled transfer.
  &quot;hybridPeeringDetails&quot;: { # HybridPeeringDetails contains details about the hybrid peering. # Output only. Hybrid peering details.
    &quot;command&quot;: &quot;A String&quot;, # Output only. Copy-paste-able commands to be used on user&#x27;s ONTAP to accept peering requests.
    &quot;commandExpiryTime&quot;: &quot;A String&quot;, # Output only. Expiration time for the peering command to be executed on user&#x27;s ONTAP.
    &quot;passphrase&quot;: &quot;A String&quot;, # Output only. Temporary passphrase generated to accept cluster peering command.
    &quot;peerClusterName&quot;: &quot;A String&quot;, # Output only. Name of the user&#x27;s local source cluster to be peered with the destination cluster.
    &quot;peerSvmName&quot;: &quot;A String&quot;, # Output only. Name of the user&#x27;s local source vserver svm to be peered with the destination vserver svm.
    &quot;peerVolumeName&quot;: &quot;A String&quot;, # Output only. Name of the user&#x27;s local source volume to be peered with the destination volume.
    &quot;subnetIp&quot;: &quot;A String&quot;, # Output only. IP address of the subnet.
  },
  &quot;hybridReplicationType&quot;: &quot;A String&quot;, # Output only. Type of the hybrid replication.
  &quot;hybridReplicationUserCommands&quot;: { # UserCommands contains the commands to be executed by the customer. # Output only. Copy pastable snapmirror commands to be executed on onprem cluster by the customer.
    &quot;commands&quot;: [ # Output only. List of commands to be executed by the customer.
      &quot;A String&quot;,
    ],
  },
  &quot;labels&quot;: { # Resource labels to represent user provided metadata.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;mirrorState&quot;: &quot;A String&quot;, # Output only. Indicates the state of mirroring.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.
  &quot;replicationSchedule&quot;: &quot;A String&quot;, # Required. Indicates the schedule for replication.
  &quot;role&quot;: &quot;A String&quot;, # Output only. Indicates whether this points to source or destination.
  &quot;sourceVolume&quot;: &quot;A String&quot;, # Output only. Full name of source volume resource. Example : &quot;projects/{project}/locations/{location}/volumes/{volume_id}&quot;
  &quot;state&quot;: &quot;A String&quot;, # Output only. State of the replication.
  &quot;stateDetails&quot;: &quot;A String&quot;, # Output only. State details of the replication.
  &quot;transferStats&quot;: { # TransferStats reports all statistics related to replication transfer. # Output only. Replication transfer statistics.
    &quot;lagDuration&quot;: &quot;A String&quot;, # Lag duration indicates the duration by which Destination region volume content lags behind the primary region volume content.
    &quot;lastTransferBytes&quot;: &quot;A String&quot;, # Last transfer size in bytes.
    &quot;lastTransferDuration&quot;: &quot;A String&quot;, # Time taken during last transfer.
    &quot;lastTransferEndTime&quot;: &quot;A String&quot;, # Time when last transfer completed.
    &quot;lastTransferError&quot;: &quot;A String&quot;, # A message describing the cause of the last transfer failure.
    &quot;totalTransferDuration&quot;: &quot;A String&quot;, # Cumulative time taken across all transfers for the replication relationship.
    &quot;transferBytes&quot;: &quot;A String&quot;, # Cumulative bytes transferred so far for the replication relationship.
    &quot;updateTime&quot;: &quot;A String&quot;, # Time when progress was updated last.
  },
}

  updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="resume">resume(name, body=None, x__xgafv=None)</code>
  <pre>Resume Cross Region Replication.

Args:
  name: string, Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # ResumeReplicationRequest resumes a stopped replication.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="reverseDirection">reverseDirection(name, body=None, x__xgafv=None)</code>
  <pre>Reverses direction of replication. Source becomes destination and destination becomes source.

Args:
  name: string, Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # ReverseReplicationDirectionRequest reverses direction of replication. Source becomes destination and destination becomes source.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code>
  <pre>Stop Cross Region Replication.

Args:
  name: string, Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # StopReplicationRequest stops a replication until resumed.
  &quot;force&quot;: True or False, # Indicates whether to stop replication forcefully while data transfer is in progress. Warning! if force is true, this will abort any current transfers and can lead to data loss due to partial transfer. If force is false, stop replication will fail while data transfer is in progress and you will need to retry later.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="sync">sync(name, body=None, x__xgafv=None)</code>
  <pre>Syncs the replication. This will invoke one time volume data transfer from source to destination.

Args:
  name: string, Required. The resource name of the replication, in the format of projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # SyncReplicationRequest syncs the replication from source to destination.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

</body></html>